GET v1/Upsells/{siteId}

Returns upsells for given items according to definition in web admin

URI template

v1/Upsells/{siteId}?menuId={menuId}&salesItemIds[0]={salesItemIds[0]}&salesItemIds[1]={salesItemIds[1]}

Request Information

URI Parameters

Name	Description	Type	Additional information
siteId	site ID	integer	Required
menuId	menu ID	integer	Required
salesItemIds	list of items IDs	Collection of integer	Required

Body Parameters

None.

Response Information

Resource Description

UpsellItemGroupSuggestionsResult

Name	Description	Type	Additional information
UpsellGroupSuggestions		Collection of UpsellSuggestionGroup	None.
UpsellMenuItemSuggestions		Collection of UpsellMenuItemSuggestion	None.

Response Formats

application/json, text/json

Sample:

{
  "UpsellGroupSuggestions": [
    {
      "$id": "2",
      "TriggeringSalesItemIds": [
        1,
        2
      ],
      "SuggestionId": 3,
      "SalesItemGroupId": 4,
      "SuggestionDisplay": "sample string 5",
      "Sequence": 6,
      "IsSuggestedAsQuantity": true
    },
    {
      "$id": "3",
      "TriggeringSalesItemIds": [
        8,
        9
      ],
      "SuggestionId": 10,
      "SalesItemGroupId": 11,
      "SuggestionDisplay": "sample string 12",
      "Sequence": 13,
      "IsSuggestedAsQuantity": true
    }
  ],
  "UpsellMenuItemSuggestions": [
    {
      "$id": "4",
      "UpsellGroupSuggestionIds": [
        15,
        16
      ],
      "SalesItemId": 17,
      "MenuItem": {
        "$id": "5",
        "MenuItemId": 18,
        "Type": "MenuItem",
        "ExternalReferenceId": 19,
        "Name": "sample string 20",
        "Description": "sample string 21",
        "DefaultItemId": 22,
        "ItemOrderingMode": 0,
        "DisplayName": "sample string 23",
        "BaseImageName": "sample string 24",
        "ListImageName": "sample string 25",
        "SalesItemIds": [
          26,
          27
        ],
        "SalesGroups": [
          {
            "$id": "6",
            "SalesGroupId": 28,
            "MenuItemId": 29,
            "ExternalId": "sample string 30",
            "Name": "sample string 31",
            "Description": "sample string 32",
            "HtmlFragment": "sample string 33",
            "LayoutBindingTag": "sample string 34",
            "Minimum": 35,
            "Maximum": 36,
            "IsVisible": true,
            "SalesItemIds": [
              38,
              39
            ],
            "Ranking": 40,
            "DefaultSalesItemId": 41,
            "DisplayName": "sample string 42"
          },
          {
            "$id": "7",
            "SalesGroupId": 43,
            "MenuItemId": 44,
            "ExternalId": "sample string 45",
            "Name": "sample string 46",
            "Description": "sample string 47",
            "HtmlFragment": "sample string 48",
            "LayoutBindingTag": "sample string 49",
            "Minimum": 50,
            "Maximum": 51,
            "IsVisible": true,
            "SalesItemIds": [
              53,
              54
            ],
            "Ranking": 55,
            "DefaultSalesItemId": 56,
            "DisplayName": "sample string 57"
          }
        ],
        "PromoId": 58,
        "IsVisible": true,
        "Price": 60.0,
        "PriceChanges": {
          "$id": "8",
          "BasePrice": 61.0,
          "Changes": [
            {
              "$id": "9",
              "Price": 62.0,
              "PriceSourceInfo": "sample string 63",
              "Start": "00:00:00",
              "End": "00:00:00"
            },
            {
              "$id": "10",
              "Price": 64.0,
              "PriceSourceInfo": "sample string 65",
              "Start": "00:00:00",
              "End": "00:00:00"
            }
          ]
        },
        "DaysOfWeekAvailable": [
          0,
          0
        ],
        "CaloricServingUnit": "sample string 66",
        "Icons": [
          "sample string 67",
          "sample string 68"
        ],
        "CaloricValue": 69,
        "CustomFields": [
          {
            "$id": "11",
            "Name": "sample string 70",
            "Value": "sample string 71"
          },
          {
            "$id": "12",
            "Name": "sample string 72",
            "Value": "sample string 73"
          }
        ],
        "SupportedOrderModes": [
          1,
          1
        ]
      }
    },
    {
      "$id": "13",
      "UpsellGroupSuggestionIds": [
        74,
        75
      ],
      "SalesItemId": 76,
      "MenuItem": {
        "$id": "14",
        "MenuItemId": 77,
        "Type": "MenuItem",
        "ExternalReferenceId": 78,
        "Name": "sample string 79",
        "Description": "sample string 80",
        "DefaultItemId": 81,
        "ItemOrderingMode": 0,
        "DisplayName": "sample string 82",
        "BaseImageName": "sample string 83",
        "ListImageName": "sample string 84",
        "SalesItemIds": [
          85,
          86
        ],
        "SalesGroups": [
          {
            "$id": "15",
            "SalesGroupId": 87,
            "MenuItemId": 88,
            "ExternalId": "sample string 89",
            "Name": "sample string 90",
            "Description": "sample string 91",
            "HtmlFragment": "sample string 92",
            "LayoutBindingTag": "sample string 93",
            "Minimum": 94,
            "Maximum": 95,
            "IsVisible": true,
            "SalesItemIds": [
              97,
              98
            ],
            "Ranking": 99,
            "DefaultSalesItemId": 100,
            "DisplayName": "sample string 101"
          },
          {
            "$id": "16",
            "SalesGroupId": 102,
            "MenuItemId": 103,
            "ExternalId": "sample string 104",
            "Name": "sample string 105",
            "Description": "sample string 106",
            "HtmlFragment": "sample string 107",
            "LayoutBindingTag": "sample string 108",
            "Minimum": 109,
            "Maximum": 110,
            "IsVisible": true,
            "SalesItemIds": [
              112,
              113
            ],
            "Ranking": 114,
            "DefaultSalesItemId": 115,
            "DisplayName": "sample string 116"
          }
        ],
        "PromoId": 117,
        "IsVisible": true,
        "Price": 119.0,
        "PriceChanges": {
          "$id": "17",
          "BasePrice": 120.0,
          "Changes": [
            {
              "$id": "18",
              "Price": 121.0,
              "PriceSourceInfo": "sample string 122",
              "Start": "00:00:00",
              "End": "00:00:00"
            },
            {
              "$id": "19",
              "Price": 123.0,
              "PriceSourceInfo": "sample string 124",
              "Start": "00:00:00",
              "End": "00:00:00"
            }
          ]
        },
        "DaysOfWeekAvailable": [
          0,
          0
        ],
        "CaloricServingUnit": "sample string 125",
        "Icons": [
          "sample string 126",
          "sample string 127"
        ],
        "CaloricValue": 128,
        "CustomFields": [
          {
            "$id": "20",
            "Name": "sample string 129",
            "Value": "sample string 130"
          },
          {
            "$id": "21",
            "Name": "sample string 131",
            "Value": "sample string 132"
          }
        ],
        "SupportedOrderModes": [
          1,
          1
        ]
      }
    }
  ]
}

application/xml, text/xml

Sample:

<UpsellItemGroupSuggestionsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1.Response">
  <UpsellGroupSuggestions>
    <UpsellSuggestionGroup>
      <IsSuggestedAsQuantity>true</IsSuggestedAsQuantity>
      <SalesItemGroupId>4</SalesItemGroupId>
      <Sequence>6</Sequence>
      <SuggestionDisplay>sample string 5</SuggestionDisplay>
      <SuggestionId>3</SuggestionId>
      <TriggeringSalesItemIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
      </TriggeringSalesItemIds>
    </UpsellSuggestionGroup>
    <UpsellSuggestionGroup>
      <IsSuggestedAsQuantity>true</IsSuggestedAsQuantity>
      <SalesItemGroupId>11</SalesItemGroupId>
      <Sequence>13</Sequence>
      <SuggestionDisplay>sample string 12</SuggestionDisplay>
      <SuggestionId>10</SuggestionId>
      <TriggeringSalesItemIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>8</d4p1:long>
        <d4p1:long>9</d4p1:long>
      </TriggeringSalesItemIds>
    </UpsellSuggestionGroup>
  </UpsellGroupSuggestions>
  <UpsellMenuItemSuggestions>
    <UpsellMenuItemSuggestion>
      <MenuItem xmlns:d4p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1">
        <d4p1:BaseImageName>sample string 24</d4p1:BaseImageName>
        <d4p1:CaloricServingUnit>sample string 66</d4p1:CaloricServingUnit>
        <d4p1:CaloricValue>69</d4p1:CaloricValue>
        <d4p1:CustomFields xmlns:d5p1="http://schemas.datacontract.org/2004/07/Radiant.Order.Shared.Contracts.ServiceEntities">
          <d5p1:CustomField>
            <d5p1:Name>sample string 70</d5p1:Name>
            <d5p1:Value>sample string 71</d5p1:Value>
          </d5p1:CustomField>
          <d5p1:CustomField>
            <d5p1:Name>sample string 72</d5p1:Name>
            <d5p1:Value>sample string 73</d5p1:Value>
          </d5p1:CustomField>
        </d4p1:CustomFields>
        <d4p1:DaysOfWeekAvailable xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DayOfWeek>Sunday</d5p1:DayOfWeek>
          <d5p1:DayOfWeek>Sunday</d5p1:DayOfWeek>
        </d4p1:DaysOfWeekAvailable>
        <d4p1:DefaultItemId>22</d4p1:DefaultItemId>
        <d4p1:Description>sample string 21</d4p1:Description>
        <d4p1:DisplayName>sample string 23</d4p1:DisplayName>
        <d4p1:ExternalReferenceId>19</d4p1:ExternalReferenceId>
        <d4p1:Icons xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 67</d5p1:string>
          <d5p1:string>sample string 68</d5p1:string>
        </d4p1:Icons>
        <d4p1:IsVisible>true</d4p1:IsVisible>
        <d4p1:ItemOrderingMode>Normal</d4p1:ItemOrderingMode>
        <d4p1:ListImageName>sample string 25</d4p1:ListImageName>
        <d4p1:MenuItemId>18</d4p1:MenuItemId>
        <d4p1:Name>sample string 20</d4p1:Name>
        <d4p1:Price>60</d4p1:Price>
        <d4p1:PriceChanges>
          <d4p1:BasePrice>61</d4p1:BasePrice>
          <d4p1:Changes>
            <d4p1:PriceTimeInterval>
              <d4p1:End>00:00:00</d4p1:End>
              <d4p1:Price>62</d4p1:Price>
              <d4p1:PriceSourceInfo>sample string 63</d4p1:PriceSourceInfo>
              <d4p1:Start>00:00:00</d4p1:Start>
            </d4p1:PriceTimeInterval>
            <d4p1:PriceTimeInterval>
              <d4p1:End>00:00:00</d4p1:End>
              <d4p1:Price>64</d4p1:Price>
              <d4p1:PriceSourceInfo>sample string 65</d4p1:PriceSourceInfo>
              <d4p1:Start>00:00:00</d4p1:Start>
            </d4p1:PriceTimeInterval>
          </d4p1:Changes>
        </d4p1:PriceChanges>
        <d4p1:PromoId>58</d4p1:PromoId>
        <d4p1:SalesGroups>
          <d4p1:SalesGroup>
            <d4p1:DefaultSalesItemId>41</d4p1:DefaultSalesItemId>
            <d4p1:Description>sample string 32</d4p1:Description>
            <d4p1:DisplayName>sample string 42</d4p1:DisplayName>
            <d4p1:ExternalId>sample string 30</d4p1:ExternalId>
            <d4p1:HtmlFragment>sample string 33</d4p1:HtmlFragment>
            <d4p1:IsVisible>true</d4p1:IsVisible>
            <d4p1:LayoutBindingTag>sample string 34</d4p1:LayoutBindingTag>
            <d4p1:Maximum>36</d4p1:Maximum>
            <d4p1:MenuItemId>29</d4p1:MenuItemId>
            <d4p1:Minimum>35</d4p1:Minimum>
            <d4p1:Name>sample string 31</d4p1:Name>
            <d4p1:Ranking>40</d4p1:Ranking>
            <d4p1:SalesGroupId>28</d4p1:SalesGroupId>
            <d4p1:SalesItemIds xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:long>38</d7p1:long>
              <d7p1:long>39</d7p1:long>
            </d4p1:SalesItemIds>
          </d4p1:SalesGroup>
          <d4p1:SalesGroup>
            <d4p1:DefaultSalesItemId>56</d4p1:DefaultSalesItemId>
            <d4p1:Description>sample string 47</d4p1:Description>
            <d4p1:DisplayName>sample string 57</d4p1:DisplayName>
            <d4p1:ExternalId>sample string 45</d4p1:ExternalId>
            <d4p1:HtmlFragment>sample string 48</d4p1:HtmlFragment>
            <d4p1:IsVisible>true</d4p1:IsVisible>
            <d4p1:LayoutBindingTag>sample string 49</d4p1:LayoutBindingTag>
            <d4p1:Maximum>51</d4p1:Maximum>
            <d4p1:MenuItemId>44</d4p1:MenuItemId>
            <d4p1:Minimum>50</d4p1:Minimum>
            <d4p1:Name>sample string 46</d4p1:Name>
            <d4p1:Ranking>55</d4p1:Ranking>
            <d4p1:SalesGroupId>43</d4p1:SalesGroupId>
            <d4p1:SalesItemIds xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:long>53</d7p1:long>
              <d7p1:long>54</d7p1:long>
            </d4p1:SalesItemIds>
          </d4p1:SalesGroup>
        </d4p1:SalesGroups>
        <d4p1:SalesItemIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:long>26</d5p1:long>
          <d5p1:long>27</d5p1:long>
        </d4p1:SalesItemIds>
        <d4p1:SupportedOrderModes xmlns:d5p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Common.Models.v1">
          <d5p1:OrderModeType>Pickup</d5p1:OrderModeType>
          <d5p1:OrderModeType>Pickup</d5p1:OrderModeType>
        </d4p1:SupportedOrderModes>
        <d4p1:Type>MenuItem</d4p1:Type>
      </MenuItem>
      <SalesItemId>17</SalesItemId>
      <UpsellGroupSuggestionIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>15</d4p1:long>
        <d4p1:long>16</d4p1:long>
      </UpsellGroupSuggestionIds>
    </UpsellMenuItemSuggestion>
    <UpsellMenuItemSuggestion>
      <MenuItem xmlns:d4p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1">
        <d4p1:BaseImageName>sample string 83</d4p1:BaseImageName>
        <d4p1:CaloricServingUnit>sample string 125</d4p1:CaloricServingUnit>
        <d4p1:CaloricValue>128</d4p1:CaloricValue>
        <d4p1:CustomFields xmlns:d5p1="http://schemas.datacontract.org/2004/07/Radiant.Order.Shared.Contracts.ServiceEntities">
          <d5p1:CustomField>
            <d5p1:Name>sample string 129</d5p1:Name>
            <d5p1:Value>sample string 130</d5p1:Value>
          </d5p1:CustomField>
          <d5p1:CustomField>
            <d5p1:Name>sample string 131</d5p1:Name>
            <d5p1:Value>sample string 132</d5p1:Value>
          </d5p1:CustomField>
        </d4p1:CustomFields>
        <d4p1:DaysOfWeekAvailable xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DayOfWeek>Sunday</d5p1:DayOfWeek>
          <d5p1:DayOfWeek>Sunday</d5p1:DayOfWeek>
        </d4p1:DaysOfWeekAvailable>
        <d4p1:DefaultItemId>81</d4p1:DefaultItemId>
        <d4p1:Description>sample string 80</d4p1:Description>
        <d4p1:DisplayName>sample string 82</d4p1:DisplayName>
        <d4p1:ExternalReferenceId>78</d4p1:ExternalReferenceId>
        <d4p1:Icons xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 126</d5p1:string>
          <d5p1:string>sample string 127</d5p1:string>
        </d4p1:Icons>
        <d4p1:IsVisible>true</d4p1:IsVisible>
        <d4p1:ItemOrderingMode>Normal</d4p1:ItemOrderingMode>
        <d4p1:ListImageName>sample string 84</d4p1:ListImageName>
        <d4p1:MenuItemId>77</d4p1:MenuItemId>
        <d4p1:Name>sample string 79</d4p1:Name>
        <d4p1:Price>119</d4p1:Price>
        <d4p1:PriceChanges>
          <d4p1:BasePrice>120</d4p1:BasePrice>
          <d4p1:Changes>
            <d4p1:PriceTimeInterval>
              <d4p1:End>00:00:00</d4p1:End>
              <d4p1:Price>121</d4p1:Price>
              <d4p1:PriceSourceInfo>sample string 122</d4p1:PriceSourceInfo>
              <d4p1:Start>00:00:00</d4p1:Start>
            </d4p1:PriceTimeInterval>
            <d4p1:PriceTimeInterval>
              <d4p1:End>00:00:00</d4p1:End>
              <d4p1:Price>123</d4p1:Price>
              <d4p1:PriceSourceInfo>sample string 124</d4p1:PriceSourceInfo>
              <d4p1:Start>00:00:00</d4p1:Start>
            </d4p1:PriceTimeInterval>
          </d4p1:Changes>
        </d4p1:PriceChanges>
        <d4p1:PromoId>117</d4p1:PromoId>
        <d4p1:SalesGroups>
          <d4p1:SalesGroup>
            <d4p1:DefaultSalesItemId>100</d4p1:DefaultSalesItemId>
            <d4p1:Description>sample string 91</d4p1:Description>
            <d4p1:DisplayName>sample string 101</d4p1:DisplayName>
            <d4p1:ExternalId>sample string 89</d4p1:ExternalId>
            <d4p1:HtmlFragment>sample string 92</d4p1:HtmlFragment>
            <d4p1:IsVisible>true</d4p1:IsVisible>
            <d4p1:LayoutBindingTag>sample string 93</d4p1:LayoutBindingTag>
            <d4p1:Maximum>95</d4p1:Maximum>
            <d4p1:MenuItemId>88</d4p1:MenuItemId>
            <d4p1:Minimum>94</d4p1:Minimum>
            <d4p1:Name>sample string 90</d4p1:Name>
            <d4p1:Ranking>99</d4p1:Ranking>
            <d4p1:SalesGroupId>87</d4p1:SalesGroupId>
            <d4p1:SalesItemIds xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:long>97</d7p1:long>
              <d7p1:long>98</d7p1:long>
            </d4p1:SalesItemIds>
          </d4p1:SalesGroup>
          <d4p1:SalesGroup>
            <d4p1:DefaultSalesItemId>115</d4p1:DefaultSalesItemId>
            <d4p1:Description>sample string 106</d4p1:Description>
            <d4p1:DisplayName>sample string 116</d4p1:DisplayName>
            <d4p1:ExternalId>sample string 104</d4p1:ExternalId>
            <d4p1:HtmlFragment>sample string 107</d4p1:HtmlFragment>
            <d4p1:IsVisible>true</d4p1:IsVisible>
            <d4p1:LayoutBindingTag>sample string 108</d4p1:LayoutBindingTag>
            <d4p1:Maximum>110</d4p1:Maximum>
            <d4p1:MenuItemId>103</d4p1:MenuItemId>
            <d4p1:Minimum>109</d4p1:Minimum>
            <d4p1:Name>sample string 105</d4p1:Name>
            <d4p1:Ranking>114</d4p1:Ranking>
            <d4p1:SalesGroupId>102</d4p1:SalesGroupId>
            <d4p1:SalesItemIds xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:long>112</d7p1:long>
              <d7p1:long>113</d7p1:long>
            </d4p1:SalesItemIds>
          </d4p1:SalesGroup>
        </d4p1:SalesGroups>
        <d4p1:SalesItemIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:long>85</d5p1:long>
          <d5p1:long>86</d5p1:long>
        </d4p1:SalesItemIds>
        <d4p1:SupportedOrderModes xmlns:d5p1="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Common.Models.v1">
          <d5p1:OrderModeType>Pickup</d5p1:OrderModeType>
          <d5p1:OrderModeType>Pickup</d5p1:OrderModeType>
        </d4p1:SupportedOrderModes>
        <d4p1:Type>MenuItem</d4p1:Type>
      </MenuItem>
      <SalesItemId>76</SalesItemId>
      <UpsellGroupSuggestionIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>74</d4p1:long>
        <d4p1:long>75</d4p1:long>
      </UpsellGroupSuggestionIds>
    </UpsellMenuItemSuggestion>
  </UpsellMenuItemSuggestions>
</UpsellItemGroupSuggestionsResult>